home *** CD-ROM | disk | FTP | other *** search
/ User's Choice Windows CD / User's Choice Windows CD (CMS Software)(1993).iso / windows1 / cpvb20.zip / CPVBLHA.EXE / CPVB.DOC < prev    next >
Text File  |  1992-08-31  |  18KB  |  516 lines
  1.                 |
  2.                 |
  3.                 |
  4.                 |
  5.                 |      Code.Print for Visual Basic
  6.                 |
  7.                 |      Copyright(c) 1991, 1992
  8.                 |
  9.                 |      Caladonia Systems, Inc.
  10.                 |
  11.                 |
  12.                 |
  13.                 |
  14.                 |
  15.                 |                     _______
  16.                 |                ____|__     |               (R)
  17.                 |             --|       |    |-------------------
  18.                 |               |   ____|__  |  Association of
  19.                 |               |  |       |_|  Shareware
  20.                 |               |__|   o   |    Professionals
  21.                 |             -----|   |   |---------------------
  22.                 |                  |___|___|    MEMBER
  23.                 |
  24.                 |
  25.                 |
  26.                 |
  27.                 |
  28.                 |
  29.                 |
  30.                 |
  31.                 |
  32.                 |
  33.                 |
  34.                 |
  35.                 |
  36.                 |
  37.                 |
  38.                 |
  39.                 |
  40.                 |
  41.                 |
  42.                 |
  43.                 |
  44.                 |
  45.                 |
  46.                 |
  47.                 |
  48.                 |
  49.                 |
  50.                 |
  51.                 |
  52.                 |
  53.                 |
  54.                 |
  55.                 |
  56.  
  57.  
  58.  
  59.  
  60.         Caladonia Systems, Inc.                                    CPVB.DOC
  61.  
  62.         TABLE OF CONTENTS
  63.         -----------------------------------------------------------------
  64.         GENERAL..................................................3
  65.         HOW Code.Print for Visual Basic PRINTS...................4
  66.         PRINTING FROM PROJECT MAKE FILES.........................4
  67.         PRINTING SINGLE FILES....................................5
  68.         PRINTING SINGLE ROUTINES.................................5
  69.         CONFIGURATION AND OPTIONS................................6
  70.         MENU FILE COMMAND........................................9
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.         Code.Print for Visual Basic                          Page 2 of 9
  114.  
  115.  
  116.         Caladonia Systems, Inc.                                    CPVB.DOC
  117.  
  118.  
  119.  
  120.         GENERAL:
  121.         ------------------------------------------------------------
  122.         Code.Print for Visual Basic is designed to provide the
  123.         developer with an affordable, capable tool to produce easily
  124.         maintainable presentation quality source code documentation.
  125.         Code.Print for Visual Basic provides the user with a rich
  126.         set of printing options:
  127.  
  128.         Header/Footer Options:
  129.  
  130.         Date and Time
  131.         Project Name
  132.         File Name
  133.         Header/Footer Notes
  134.         Routine Name
  135.         Page Numbers
  136.         Continuous page numbering
  137.         Starting Page
  138.         Three header lines for additional notes
  139.  
  140.         Footers:
  141.  
  142.         Three footer lines
  143.  
  144.         Page and Output Options:
  145.  
  146.         Line Spacing
  147.         Top, Bottom, Left and Right Margin Control
  148.         Sort Output by Sub-Routine
  149.         Sort File by Sub-Routine
  150.         Serialize Backups
  151.         Page Breaks on New Routines
  152.         Fit Subroutine on Page
  153.         Background Printing
  154.         Bold Routine Name
  155.         Subroutine Index
  156.  
  157.         Fonts:
  158.  
  159.         Individual fonts, styles, and sizes can be designated for
  160.         Header/Footer, Procedure Title, Comment, and Code lines.
  161.         Any font available to the printer is available for your
  162.         selection.
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.         Code.Print for Visual Basic                          Page 3 of 9
  170.  
  171.  
  172.         Caladonia Systems, Inc.                                    CPVB.DOC
  173.  
  174.         HOW Code.Print for Visual Basic PRINTS:
  175.         ------------------------------------------------------------
  176.  
  177.         Code.Print for Visual Basic does not print directly from
  178.         Visual Basic .FRM or .BAS files.  These files are in a
  179.         proprietary binary format and thus are not decodable for
  180.         printing purposes.
  181.  
  182.         Code.Print for Visual Basic prints from .TXT files created
  183.         in Visual Basic with the CODE SAVE TEXT command.  Files
  184.         created in this manner are readable by Code.Print for Visual
  185.         Basic.  Although Code.Print prints only text files, it does
  186.         try to determine what Visual Basic source file (.FRM or .BAS)
  187.         the text file belongs to and uses the source file name in the
  188.         printed output and print status box.
  189.         Note: Although you can create your text files by hand using
  190.         the SAVE TEXT command, a utility is available from Caladonia
  191.         Systems, TexMake, that automates this generation process.
  192.  
  193.         Users can print files created with other editors provided
  194.         they are in TEXT format.  Be sure to set the sort options
  195.         off and set the comment font attributes the same as your
  196.         code font settings if you want to print non-program source
  197.         code text files.
  198.  
  199.  
  200.         PRINTING FROM PROJECT MAKE FILES:
  201.         --------------------------------------------------------------
  202.         Code.Print for Visual Basic is capable of reading project
  203.         MAK files.  By selecting a MAK file in the File List Box,
  204.         Code.Print for Visual Basic builds a sorted list of all
  205.         forms and modules and proceeds to find and print all
  206.         associated TXT code files available.  This enables the user
  207.         to print an entire application with one command.
  208.  
  209.         To print from a project make file, select the MAK file you
  210.         want in the FILE list box.  (You can also type the name of
  211.         the file in the text box directly.  Be sure to include the
  212.         .MAK extension.)  Select FILE PRINT (Ctrl-P) to start
  213.         printing.
  214.  
  215.         When Code.Print for Visual Basic prints from a MAK file,
  216.         page numbers increment continuously until the end of the
  217.         print job if Countinuous is checked in the Header/Footer
  218.         Options group.  Otherwise page numbers reset to the starting
  219.         page with each new text file.  Page number references in
  220.         the index reflect whatever page numbering method was used.
  221.  
  222.  
  223.  
  224.  
  225.         Code.Print for Visual Basic                          Page 4 of 9
  226.  
  227.  
  228.         Caladonia Systems, Inc.                                    CPVB.DOC
  229.  
  230.         Tip:
  231.  
  232.         Although Visual Basic allows you to have a form and module
  233.         with the same name in a project (ie. SAMPLE.FRM and
  234.         SAMPLE.BAS,) only one of the files can have a text code file
  235.         (ie. SAMPLE.TXT)  Code.Print for Visual Basic will print the
  236.         text file twice, once for each occurrence of the root name
  237.         in the project make file.  To avoid this confusion, give
  238.         each form and module file in a project a unique name.
  239.  
  240.  
  241.  
  242.         PRINTING SINGLE FILES:
  243.         -------------------------------------------------------------
  244.  
  245.         To print a single file, select the TXT file you want in the
  246.         FILE list box.
  247.  
  248.         (You can also type the name of the file in the text box
  249.         directly.  Be sure to include the .TXT extension.)
  250.  
  251.         Select FILE PRINT (Ctrl-P) to start printing.
  252.  
  253.  
  254.  
  255.         PRINTING SINGLE ROUTINES:
  256.         -------------------------------------------------------------
  257.  
  258.         To print a single procedure within a code file, select the
  259.         TXT file you want in the FILE list box.
  260.  
  261.         (You can also type the name of the file in the text box
  262.         directly.  Be sure to include the .TXT extension.)
  263.  
  264.         Code.Print will scan the file and make a sorted list of the
  265.         procedures it finds.  This list appears in the PROCEDURES
  266.         box.  The default procedure is [All].
  267.  
  268.         Select the procedure you wish to print and then select FILE
  269.         PRINT (Ctrl-P) to start printing.
  270.         Select [Declarations] to print only the declarations section
  271.         of a TXT file.
  272.  
  273.         Code.Print for Visual Basic does not print an index when
  274.         printing single routines.
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.         Code.Print for Visual Basic                          Page 5 of 9
  282.  
  283.  
  284.         Caladonia Systems, Inc.                                    CPVB.DOC
  285.  
  286.         CONFIGURATION AND OPTIONS:
  287.         ----------------------------------------------------------------
  288.  
  289.         Overview:
  290.  
  291.         CURRENT SETTINGS and STARTUP CONFIGURATION
  292.         windows are identical in appearance and use.  The two
  293.         differ in that startup configuration settings are saved
  294.         to disk and are set when the program loads.
  295.  
  296.         CURRENT SETTINGS enables you to change any settings
  297.         during the current session.  They remain in effect until
  298.         changed or the program is exited.
  299.  
  300.         The CURRENT SETTINGS window also contains a
  301.         command button labeled DEFAULT.  Pressing DEFAULT
  302.         resets all options to pre-set values.
  303.  
  304.  
  305.         Saving Configurations and Settings:
  306.  
  307.         If you are in the CURRENT SETTINGS window, settings are
  308.         saved as they are changed.  The OK button restores the
  309.         Main Window.
  310.  
  311.         The STARTUP CONFIGURATION window has SAVE and
  312.         CANCEL buttons.  Pressing SAVE will write the
  313.         configuration settings to disk.  Pressing CANCEL
  314.         will exit the window without saving the changes.
  315.  
  316.  
  317.         Header/Footer Options:
  318.  
  319.         Date and Time - Check this box to print Date and Time.
  320.  
  321.         Project Name  - Check this box to print Project Name.
  322.  
  323.         Project Name Text - If Project Name is checked you
  324.         can enter text into the Project Name Text box.
  325.  
  326.         File Name     - Check this box to print TXT file name.
  327.  
  328.         Include Path  - Check this box to print the full path
  329.         name of the file.
  330.  
  331.         Header/Footer Notes - Check this box to print header
  332.         and footer notes, if they exist.
  333.         Header/Footer Border Lines  - Check this box to print
  334.         horizontal lines that separate the header and footer from
  335.         the source code print area.
  336.         Print Routine Name  - Check this box to print the name
  337.         of the routine on the title line.
  338.  
  339.         Code.Print for Visual Basic                          Page 6 of 9
  340.  
  341.  
  342.         Caladonia Systems, Inc.                                    CPVB.DOC
  343.  
  344.         Page Numbers  - Check this box to print page numbers.
  345.  
  346.         Continuous  - Check this box to print page numbers
  347.         without resetting to 1 at the start of a new file.
  348.         This option works only when printing from a MAK file.
  349.         Starting Page - Enter the page number to start (default 1).
  350.  
  351.         Date, Project, Filename, Header Notes, and Print Routine
  352.         Name can be limited to print on the First Page Only for
  353.         each TXT file.  Check the Page 1 Only box next to the
  354.         option you want to limit.
  355.  
  356.         Fonts:
  357.  
  358.         Individual fonts, styles, and sizes can be designated for
  359.         Header/Footer, Procedure Title, Comment, and Code lines.
  360.         Any font available to the printer is available for your
  361.         selection but must first be assigned to the Code.Print
  362.         font set. (See Font Setup.)
  363.  
  364.         To change a font, press the FONT list button.  Select the
  365.         desired font by double clicking on it.
  366.  
  367.         Font Sizes:
  368.  
  369.         To select a font size, press the SIZE list button for the
  370.         font you want to change.  Select the size you want.
  371.  
  372.         Note:
  373.  
  374.         Code.Print for Visual Basic currently lacks the ability to
  375.         determine what sizes are actually available for any given
  376.         printer font (an environmental problem the folks at
  377.         Microsoft are working on).  The list presented is most
  378.         likely to be available.  If the size selected is not
  379.         available Code.Print for Visual Basic will select the
  380.         nearest usable size.
  381.  
  382.         Font Styles:
  383.  
  384.         To select a font style check the appropriate style box.
  385.         There are style check boxes for BOLD, ITALIC,
  386.         and UNDERLINE.  Normal style is the default when
  387.         no styles are checked.
  388.  
  389.         Headers and Footers:
  390.  
  391.         Header Note Lines - To enter/edit header note lines press
  392.         the EDIT HEADER/FOOTER command button.  Code.Print for
  393.         Visual Basic will display the current header lines.  Edit as
  394.         you need and press OK when done.
  395.  
  396.         Code.Print for Visual Basic                          Page 7 of 9
  397.  
  398.  
  399.         Caladonia Systems, Inc.                                    CPVB.DOC
  400.  
  401.         Footer Note Lines - To enter/edit footer note lines press
  402.         the EDIT HEADER/FOOTER command button.
  403.         Code.Print for Visual Basic will display the current
  404.         footer lines.  Edit as you need and press OK when done.
  405.  
  406.         Page and Output Setup:
  407.  
  408.         To change the Page and Output Setup press the
  409.         PAGE AND OUTPUT SETUP button on the
  410.         CURRENT SETTINGS or STARTUP
  411.         CONFIGURATION form.
  412.  
  413.         Code.Print for Visual Basic will display the Page and
  414.         Output Options form.  Press OK when finished.
  415.  
  416.         Margins - Enter the size of the margins (Select in or cm)
  417.  
  418.         Sort Output - Check this box to print the routines in each
  419.         file in alphabetical order.
  420.  
  421.         Sort File - Check this box to sort the TXT file by
  422.         procedure.  Code.Print for Visual Basic preserves the
  423.         declarations section at the top of the file.
  424.  
  425.         Serialize Backups - When Code.Print for Visual Basic sorts a
  426.         TXT file it creates a backup of the original TXT file.  If
  427.         SERIALIZE BACKUPS is checked, Code.Print for Visual Basic
  428.         copies the original file to a file with the next logical
  429.         serialized extension.  For example, with a file called
  430.         SAMPLE.TXT, say the last backup created is SAMPLE.V05.
  431.         The next backup file that Code.Print for Visual Basic
  432.         makes will be SAMPLE.V06.  Versions go from V00 to V99 and
  433.         then start over.  If SERIALIZE BACKUPS is not checked the
  434.         backup file always has the extension of BAK.
  435.  
  436.         Page Break on New Subroutine - Check this box to start a
  437.         new page for each new procedure encountered.
  438.  
  439.         Fit Subroutine on Page - Check this box to insure that any
  440.         routine that is larger then can be printed on the current
  441.         page will be printed starting at the top of the next page.
  442.         This option is not available if Page Break on New Subroutine
  443.         is checked.
  444.  
  445.         Line Spacing - Enter the line spacing you want (Default 1)
  446.  
  447.         Print Subroutine Index - Check this box to print an index of the
  448.         procedures printed during a print job.  The index lists the
  449.         procedure name, file, and page number where the procedure
  450.         was printed.  When printing from a MAK file, the index list
  451.         is alphabetized based on the entire list of procedures
  452.         encountered during the print run.  Indexes are not available
  453.         when printing single procedures.
  454.  
  455.         Code.Print for Visual Basic                          Page 8 of 9
  456.  
  457.  
  458.         Caladonia Systems, Inc.                                    CPVB.DOC
  459.  
  460.         Print While Processing - Check this box to release output to
  461.         the Print Manager as soon as each TXT file is completed.
  462.         This option will allow you to split the output of a MAK file
  463.         print job into several individual print files rather than
  464.         one very large print file.  It will also allow you to print
  465.         in background while Code.Print processes the files.
  466.  
  467.         Bold Routine Name - Check this box to highlight the name of
  468.         each subroutine or function in the printout.  Make sure your
  469.         code font is not set to bold, otherwise you will see no
  470.         difference in the output.
  471.  
  472.  
  473.  
  474.         FONT SETUP:
  475.         To improve performance, Code.Print for Visual Basic uses
  476.         a sub-set of the total fonts available to the system.
  477.         Since normal operation of Code.Print for Visual Basic
  478.         requires only a few fonts be available at any given moment
  479.         a substantial improvement in performance can be realized
  480.         by referencing this small sub-set rather than the total
  481.         fonts available.  This is especially true in cases where
  482.         the total number of fonts available is very large.
  483.  
  484.         ASSIGNING FONTS:
  485.  
  486.         To assign fonts to the Code.Print font set, select OPTIONS
  487.         FONT SETUP (Ctrl-F).
  488.  
  489.         The Font Setup window has two list boxes.  On the left is
  490.         a list of unassigned fonts available.  On the right is a
  491.         list of the current assigned Code.Print fonts.  Double
  492.         clicking on a font (or highlighting and pressing ENTER)
  493.         will move the font from one list to the other.  When you
  494.         are finished with your selections, press SAVE to set the
  495.         Code.Print font set to the assigned list.  The CANCEL
  496.         button exits the Font Setup window without changing the
  497.         current assigned font list.
  498.  
  499.         If you do not assign any fonts to the assigned font list
  500.         Code.Print will set the default font to Courier.
  501.  
  502.  
  503.         MENU FILE COMMAND:
  504.         ------------------------------------------------------------
  505.  
  506.         Print - Select this option to start a print job.  You can
  507.         also use the quick key Ctrl-P.
  508.         Print Setup - Select this option to access the Print Setup
  509.         Dialog Box
  510.         Exit - Select this option to exit the program.
  511.         You can also use the quick key Ctrl-X or select CLOSE from
  512.         the control box menu on the Code.Print for Visual Basic main
  513.         window.
  514.  
  515.         Code.Print for Visual Basic                          Page 9 of 9
  516.